JavaScript

{dialog.object}restoreListColumnLayout Method

Syntax

{dialog.object}.restoreListColumnLayout(ListId [, ListLayoutName]);

Arguments

ListIdstring

The List control to restore the layout.

ListLayoutNameCharacter

The name of the layout to restore. If not specified, the name of the layout that was saved will be used. Only applies to lists with multiple layouts.

Description

Restores a previously saved column layout for the specified List control.

{dialog.object}.restoreListColumnLayout('LIST1','columnLayout');

Videos

Saving and Restoring the List's Column Layout

The Show/hide list columns Defined Control can be used to give the user the ability to show, hide, and reorder columns in a List's layout. The layout can be saved, allowing you to later restore the layout the user created when they return to the application.

When the user changes the layout of the List columns, the onListColumnSelectorChanged event is triggered. This event can be used to persist the List's modified layout.

In this video, we show how to use the UX component's .persistListColumnLayout() and .restoreListColumnLayout() methods to save and restore the Column layout for a List control.

See Also